/*
 * Copyright 2020 eBlocker Open Source UG (haftungsbeschraenkt)
 *
 * Licensed under the EUPL, Version 1.2 or - as soon they will be
 * approved by the European Commission - subsequent versions of the EUPL
 * (the "License"); You may not use this work except in compliance with
 * the License. You may obtain a copy of the License at:
 *
 *   https://joinup.ec.europa.eu/page/eupl-text-11-12
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
 * implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */
package org.eblocker.server.common.network;

import org.eblocker.server.common.data.NetworkConfiguration;
import org.eblocker.server.common.data.NetworkStateId;

/**
 * Represents a configuration state of the network
 */
public abstract class NetworkState {
	/**
	 * Perform all steps that are necessary to leave this state,
	 * e.g. services must be stopped.
	 */
	public abstract void onExit(NetworkServices services);

	/**
	 * Perform all steps that are necessary to enter this state,
	 * e.g. services must be configured and started.
	 * @param willReboot true if the system will be rebooted afterwards
	 */
	public abstract void onEntry(NetworkServices services, NetworkConfiguration configuration, boolean willReboot);

	/**
	 * Performs all steps that are necessary to update the configuration.
	 * The default is to call onExit() and onEntry().
	 */
	public void onConfigurationUpdate(NetworkServices services, NetworkConfiguration configuration, boolean willReboot) {
		onExit(services);
		onEntry(services, configuration, willReboot);
	}

	public abstract NetworkStateId getId();
}
